home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / wildcat / calcat22.zip / CALCAT.DOC < prev    next >
Text File  |  1993-01-09  |  13KB  |  519 lines
  1.                                                                         1.
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                            CalCat! Ver 2.0
  10.                           By : Bart Flentje
  11.                           1718 Hickory Hill
  12.                            Eagan, MN 55122
  13.        
  14.        
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                                                                         2.
  68.        
  69.  
  70.  
  71.  
  72.  
  73.  
  74.        
  75.        Legal                                                            
  76.                   
  77.  
  78.        CalCat! is provided "AS IS" without any warranty of any kind,
  79.        either expressed or implied as to the merchantability or fitness
  80.        of purpose.  The risk as to the quality and performance of the
  81.        software is the end user's.  The Author shall have no liability
  82.        or responsibility to the user with respect to the liability, loss
  83.        or damage caused or alleged to be caused by this software,
  84.        including, but not limited to, any interruption of service, loss
  85.        of business or anticipatory profits or consequential damages
  86.        resulting from the use of, or the inability to use the software.
  87.  
  88.        The information in this document is subject to change without
  89.        notice and does not represent a commitment on the part of the
  90.        Author.
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.                                                                         3.
  134.        
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.        Copying and Distribution:
  142.  
  143.        CalCat!  may  be  copied and  distributed  freely.  If you
  144.        distribute CalCat! on  communications systems such as  BBS or
  145.        CompuServe,  The  Source,  Genie,  etc,  you  must  include all
  146.        of the files as  a set (using  ARC, ZIP, LZH, PAK,  etc.)
  147.        CalCat! is COPYRIGHTED and no modification may be made.  It will
  148.        be a violation to use unregistered versions past authorized date.
  149.        It is also a violation to distribute registered versions.
  150.  
  151.  
  152.  
  153.        Registration:
  154.  
  155.        CalCat! is NOT  public domain, it is SHAREWARE.  That means that 
  156.        you have to  pay registration fees ($7.00)  if you use CalCat! on  
  157.        your BBS in any way or form.  The registration cost is minimal and 
  158.        and considered to be below market standards.  Registration fee will  
  159.        allow the  author to  write new  and improved versions of CalCat!. 
  160.        Please  note  that the  unregistered  version is the  same as  the 
  161.        registered version except that the unregistered version expires on
  162.        Feb 28, 1993 or until next release to be determined by author at any
  163.        time and is subject to change without notice.  Registering your
  164.        software will give you unlimited usage with no expiration.  Also by
  165.        registering your software you will be supporting the latest release
  166.        that is presently being developed.
  167.        
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.                                                                         4.
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.  
  210.        
  211.        Description of files:
  212.  
  213.          - CALCAT.DOC    (This documentation)
  214.          - CCFIG.EXE     (**** No longer used!! ****************)
  215.          - CALCAT21.EXE  (The CalCat! program file to be run as event)
  216.          - CALCAT.BAT    (Sample batch file to start CalCat! event)
  217.          - CALCAT.CFG    (Sample .CFG file to see format.  Use CCFIG)
  218.          - ONOFF.LST     (Text file needed to turn holidays on & off)
  219.          - ADDHOL.LST    (Text file to add your own holidays)
  220.          - RELEASE.DOC   (Version release information and history)
  221.                                              
  222.          - HOLISCRN.ZIP  (Archive file containing 204 holiday screens)
  223.                                                    
  224.                                                     
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.                                                                         5.
  266.  
  267.  
  268.  
  269.  
  270.  
  271.  
  272.  
  273.        What is CalCat! ?
  274.  
  275.        CalCat! is a screen swapping utility written specifically for
  276.        Wildcat! 3.+ BBS software.  CalCat! is a screen swapper that knows
  277.        holidays.  It swaps in holiday display screens to a specified
  278.        display file when current date happens to be a holiday.  Beyond 
  279.        that, it also allows you to randomly swap of up to 100 other 
  280.        screens on a non-holiday day!  CalCat! is easy to setup and is to
  281.        be run as an event (prefered) or as postcall.bat by Wildcat!.  
  282.        It is recommended that event be setup for once each day preferably 
  283.        in the late, late morning to late night callers are aware of new daily 
  284.        changes.  There are two sets of screens for CalCat!.  CalCat! now 
  285.        allows for both @code@ and ANSI screens in one program.  This can 
  286.        be controlled in the configuration file.
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.                                                                         
  331.                                                                         6.
  332.  
  333.        How to install CalCat! ?
  334.  
  335.        To install CalCat! follow these steps:
  336.  
  337. I.  A. Copy CALCAT21.EXE, CALCAT.CFG, ADDHOL.LST, ONOFF.LST and HOLISCRN.ZIP 
  338.        to the directory where your event will run from.  ex (C:\WC30\EVENT1\)
  339.            
  340.     B. Inside this directory, make a sub directory for your screens.  Unzip 
  341.        HOLISCRN.ZIP to that sub directory that you just created.
  342.  
  343.        Here is an example of how my directory looks...         
  344.     ____________________________________________________            
  345.                 Volume in drive C is MAX1!                   
  346.                 Volume Serial Number is 18DB-9CAD            
  347.                 Directory of C:\WC30\EVENT1                  
  348.                                                              
  349.                 .            <DIR>     08-28-92   2:07p      
  350.                 ..           <DIR>     08-28-92   2:07p      
  351.                 ONOFF    LST      2158 10-31-92  11:58a     
  352.                 ADDHOL   LST        32 10-18-92   5:18p      
  353.                 CALCAT   CFG        93 10-31-92   5:39p       
  354.                 CALCAT21 EXE     76162 10-31-92  12:01p
  355.                 CALCAT   BAT        12 10-31-92  12:02p
  356.                 CALCAT   DOC      8138 10-31-92   5:53p
  357.                 SCREENS      <DIR>     10-31-92  10:07a <- Unzip screens here.
  358.                     11 file(s)     151459 bytes
  359.                                  17217536 bytes free
  360.    _____________________________________________________
  361.  
  362.     C. Be sure to be into your event directory and now we'll modify your
  363.        .CFG file to suit your needs.  Jump into your favorite text
  364.        editor and load CALCAT.CFG.
  365.             
  366.             Bart Flentje <------------ Sysop's First and Last Name
  367.             The Bad Place BBS <------- Name of BBS
  368.             HELLO9 <------------------ Title of Target Holiday Screen
  369.             C:\WC30\EVENT1\SCREENS\ <- Path of Source Holiday Screens
  370.             C:\WC30\DISP\ <----------- Path to Display Screens
  371.             @ <----------------------- Screen Code Type
  372.             3 <----------------------- Number of Screens to Swap on Non-Holiday
  373.             WCLOGO.BBS <-----------
  374.             USRLOGO.SCR <------------- Title of Screens for autoswap
  375.             BARTMAN.BBS <----------
  376.  
  377.       Line #1:  This is the first and last name of sysop.
  378.       Line #2:  The name of your BBS.
  379.       Line #3:  This is the name of the screen you want to write the 
  380.                 holiday screen to.  This can be HELLOX., GOODBYE., or
  381.                 PRELOG.  One thing to note is that you may NOT want to use
  382.                 the PRELOG. screen as your holiday screen because some of
  383.                 your users may not have ANSI.  Recommended is any HELLOX.
  384.  
  385.                 NO postfix is necessary here.  REMEMBER, NO postfix and 
  386.                 NO period.  If you forget this Wildcat may not be able
  387.                 to read in your screen.
  388.       Line #4:  This is the path of where CalCat! will find your holiday
  389.                 screens.
  390.       Line #5:  This is the path of where CalCat! will right your holiday
  391.                 screen.
  392.       Line #6:  This is the screen code.  Use an '@' for attribute screens or
  393.                 an 'A' for ANSI screens.  If this code is wrong it will 
  394.                 assume attribute screens.  This code specifies the type
  395.                 of holiday screens to use.
  396.  
  397.                                                                         7.
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.       Line #7:  Put the number of screens to randomly swap here.  A '0' will
  405.                 result in the CalCat! title screen to be copied.  A '1' will
  406.                 mean that just one screen will always be copied on a non
  407.                 holiday instead of a random swap.  For any number greater 
  408.                 than 1, it will randomly choose from number inserted here.
  409.       Line #8:  Line 8 and all lines following must contain the names of
  410.                 of screens to randomly swap on non-holidays.  These 
  411.                 titles MUST have the appropriate postfix.  You can now mix
  412.                 both attribute screens and ANSI screens.  Just be sure that
  413.                 postfix is .BBS or .SCR and CalCat! will automatically read
  414.                 it in.  Be sure that you have the same amount of screen 
  415.                 titles as the number in line #7.
  416.  
  417.  
  418.       
  419.       That should do it for the configuration file.
  420.  
  421.  
  422. II.   Edit the CALCAT.BAT file to reflect the path to where you have
  423.       elected to store the CalCat! execution program. Put it whereever
  424.       you place your event bats.
  425.  
  426.  
  427. III.  Set up event in SYSOP menu area of Wildcat! BBS using the
  428.       CALCAT.BAT sample file.  Run once per day preferably at say
  429.       12:01 A.M.  Once installed properly, event only takes
  430.       approximately 5 seconds to run so will not interfere with incoming
  431.       calls.
  432.  
  433.  
  434. IV.   You can now turn holidays on and off without removing them from
  435.       the screen directory.  This can be done using the file ONOFF.LST.
  436.       
  437.  
  438.       Inside ONOFF.LST:
  439.  
  440.            ON -NEW YEARS DAY
  441.            ON -ST. PATRICK'S DAY <----- Example of holiday a turned on.
  442.            OF -APRIL FOOL'S DAY <------ Example of holiday a turned off.
  443.              |          |
  444.              |          |
  445.              V          V            Just change the 'N' to 'F' and
  446.            ON -VALENTINE'S DAY       your holiday will turned off.
  447.            ON -INDEPENDENCE DAY
  448.            ON -HALLOWEEN
  449.            OF -ALL SAINTS DAY
  450.            ON -VETERANS DAY
  451.            *******************
  452.       
  453.       This file must exist in directory or all holidays will be assumed on!
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.                                                                       8.
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470. V.    Adding your own holidays is done by modifying the ADDHOL.LST file.
  471.       
  472.  
  473.  
  474.               1018BFBD   <--- This represents October 18th BFBD.SCR !
  475.               1220JRBD
  476.               0710CFBD   <--- This represents July 10th CFBD.SCR !
  477.                   ----
  478.                 -- |
  479.               --|  |--------- Four character screen title.  This is the
  480.               | |             title of your custom holiday screen.  Note
  481.               | |             there is no postfix here.  On the actual
  482.               | |             file there must be a .BBS or .SCR depending  
  483.               | |             on the screen code used in .CFG file.  If you
  484.               | |             used a @ symbol in .CFG file then your custom
  485.               | |             screens must be .BBS, same idea for ANSI.
  486.               | |        
  487.               | |------------ This is the day of the holiday.  Note that it              
  488.               |               is two digits.  If your holiday is on the 1st
  489.               |               day of a month, then be sure to use '01'.
  490.               |
  491.               |-------------- This is the month of your holiday.  Note that
  492.                               it is two digits.  If your holiday happens to
  493.                               be in February, be sure to use '02'.
  494.  
  495.  
  496.       Remember, if you have problems setting up CalCat!, first check the
  497.       sample files that I have sent with this.  If that doesn't work feel
  498.       free to contact me on the MSI BBS or call me voice at: 612-686-6276.
  499.  
  500.  
  501.       Last minute features added:
  502.  
  503.       - To get a list of specific dates of all holidays during the year,
  504.         use the switch 'list' after the name.  It will list them by their
  505.         database number, month, day, year, and their four character title.
  506.         (This feature will be improved in next update.)
  507.  
  508.                  For example:  CALCAT21 LIST
  509.  
  510.       - To check to see if more than one holiday lands on the same day
  511.         use the switch 'check'. (This feature to be improved next update.)
  512.               
  513.                  For example:   CALCAT21 CHECK
  514.  
  515.     
  516.     
  517.     ** Obviously DO NOT put these switches in your batch file!!!
  518.  
  519.